| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

ImageEnvironmentEffect.h
1 // ImageEnvironmentEffect.h
3 //
5
6 namespace nkAstraeus
7 {
16 class ImageEnvironmentEffect final : public Effect
17 {
18 public :
19
26 ImageEnvironmentEffect (System* system) noexcept ;
31 virtual ~ImageEnvironmentEffect () ;
32
33 // Getters
37 nkGraphics::Texture* getSourceTexture () const ;
41 nkGraphics::Sampler* getSourceSampler () const ;
45 nkGraphics::Camera* getSourceCamera () const ;
49 IMAGE_ENVIRONMENT_PROJECTION getSourceProjection () const ;
50
51 // Setters
60 void setSourceTexture (nkGraphics::Texture* value) ;
69 void setSourceSampler (nkGraphics::Sampler* value) ;
79 void setSourceCamera (nkGraphics::Camera* value) ;
92 void setSourceProjection (IMAGE_ENVIRONMENT_PROJECTION value) ;
93
94 // Load
95 virtual bool load () override ;
96 virtual void unload () override ;
97
98 public :
99
100 // Statics
111 static nkMemory::UniquePtr<ImageEnvironmentEffect> create (System* system = nullptr) ;
119 static IMAGE_ENVIRONMENT_PROJECTION getRequiredProjection (const ImageEnvironmentEffectInfo& info) ;
120 } ;
121 }
nkAstraeus::ImageEnvironmentEffect::getSourceProjection
IMAGE_ENVIRONMENT_PROJECTION getSourceProjection() const
nkAstraeus::ImageEnvironmentEffect::getRequiredProjection
static IMAGE_ENVIRONMENT_PROJECTION getRequiredProjection(const ImageEnvironmentEffectInfo &info)
nkAstraeus::ImageEnvironmentEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkGraphics::Camera
Offers all controls to model a camera.
Definition: Camera.h:14
nkAstraeus::ImageEnvironmentEffect::ImageEnvironmentEffect
ImageEnvironmentEffect(System *system) noexcept
nkAstraeus::ImageEnvironmentEffect::setSourceProjection
void setSourceProjection(IMAGE_ENVIRONMENT_PROJECTION value)
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkAstraeus::ImageEnvironmentEffect::~ImageEnvironmentEffect
virtual ~ImageEnvironmentEffect()
nkAstraeus::ImageEnvironmentEffect::create
static nkMemory::UniquePtr< ImageEnvironmentEffect > create(System *system=nullptr)
nkAstraeus::System
The main entry point for nkAstraeus engine.
Definition: System.h:15
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: BlurComplexEffect.h:7
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkAstraeus::Effect
Base class for all effects in the component.
Definition: Effect.h:16
nkAstraeus::ImageEnvironmentEffect::setSourceCamera
void setSourceCamera(nkGraphics::Camera *value)
nkAstraeus::ImageEnvironmentEffect::setSourceSampler
void setSourceSampler(nkGraphics::Sampler *value)
nkGraphics::Sampler
Holds all the information needed of a sampler used during rendering.
Definition: Sampler.h:14
nkAstraeus::ImageEnvironmentEffect::unload
virtual void unload() override
nkAstraeus::IMAGE_ENVIRONMENT_PROJECTION
IMAGE_ENVIRONMENT_PROJECTION
Enumerates the projections supported for a source environment image.
Definition: ImageEnvironmentProjection.h:12
nkAstraeus::ImageEnvironmentEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus::ImageEnvironmentEffect
Effect using a texture as an input to use it as an environment for the view.
Definition: ImageEnvironmentEffect.h:17
nkAstraeus::ImageEnvironmentEffect::load
virtual bool load() override
nkAstraeus::ImageEnvironmentEffect::getSourceCamera
nkGraphics::Camera * getSourceCamera() const
nkAstraeus::ImageEnvironmentEffect::getSourceSampler
nkGraphics::Sampler * getSourceSampler() const